/*
 * Board game - put the figures down and try to make a line.
 * Copyright (C)  2008 Georgi Staykov
 * 
 * This file is part of ClearTheLines.
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package com.gstaykov.clearthelines.figures;

import com.gstaykov.clearthelines.ImageMatrix;


public abstract class AbstractFigure {
    
    protected int posX = 0;
    protected int posY = 0;
    protected int rotPos = 0;

    /**
     * Modified playground with the applied changes
     * @param playground
     * @return true if the figure can be inited, false otherwise
     */
    public abstract boolean init(ImageMatrix playground);
    
    /**
     * Modified playground with the applied changes
     * @param playground
     * @return 
     */
    public abstract void rotate(ImageMatrix playground);

    /**
     * Modified playground with the applied changes
     * @param playground
     * @return true if the figure can go down, false otherwise
     */
    public abstract boolean goDown(ImageMatrix playground);
    
    /**
     * Modified playground with the applied changes
     * @param grapplaygroundhics
     * @return 
     */
    public abstract void goLeft(ImageMatrix playground);

    /**
     * Modified playground with the applied changes
     * @param playground
     * @return 
     */
    public abstract void goRight(ImageMatrix playground);
    
    /**
     * Modified playground with the applied changes
     * @param playground
     * @return 
     */
    protected abstract void draw(ImageMatrix playground, boolean transparent);
}
